Skip to content

Check Rue examples in-repo and add an update-rue-docs skill - #13

Merged
Rigidity merged 2 commits into
mainfrom
rigidity/update-rue-docs-skill
Nov 16, 2026
Merged

Rigidity merged 2 commits into
mainfrom
rigidity/update-rue-docs-skill

Conversation

@Rigidity

@Rigidity Rigidity commented Nov 16, 2026 •

Copy link
Copy Markdown
Collaborator

Adds an update-rue-docs skill to run each time a new Rue version is released, modelled on update-sdk-docs in xch-dev/docs. It also adds a check that compiles every Rue example in the docs, which the skill relies on.

Changes

  • .claude/skills/update-rue-docs/SKILL.md: run it as /update-rue-docs [version]. It covers:

    • diffing Rue from the version in .rue-version to the target;
    • where in the Rue source each documented area is defined;
    • which pages and summary tables go stale;
    • the docs' conventions;
    • re-testing the tutorials with a Wallet SDK release that uses the new Rue;
    • verifying with a separate reviewer, then opening a PR.
  • .rue-version: records the Rue version the docs describe (0.12.0).

  • pnpm check:rue-examples (scripts/check-rue-examples.py): checks every ```rue block with the rue CLI. Each block must:

    • compile with no errors or warnings (unused items are allowed);
    • have every test fn pass;
    • build, if it has a main;
    • be formatted the way rue fmt formats it.

    The info string after rue changes what's checked:

    • ignore skips the block (fragments, multi-file examples);
    • error means the block must fail to compile;
    • warn allows warnings;
    • nofmt skips the format check.

    The script fails if the CLI isn't the version in .rue-version. --rue <path> points it at a specific binary.

  • Docs:

  • CI: a new rue-examples job installs rue-cli at the version in .rue-version and runs the check. The binary is cached per version, so the few-minute cargo install only happens when the version changes.

  • README: documents the example check and the skill.

Note

Low Risk

Adds a script, a CI job and a skill, and only adds info strings and formatting changes to existing examples, so the rendered docs are unchanged apart from the reformatted tutorial snippets. Prettier, typecheck and build pass. The new CI job only reads the repo and installs a pinned crates.io version. The check passes against 0.12.0 and catches each kind of failure in a throwaway test page.

  • Tooling: scripts/check-rue-examples.py, .rue-version, a check:rue-examples script in package.json, and the rue-examples CI job.
  • Skill: .claude/skills/update-rue-docs/SKILL.md.
  • Docs: info strings on 18 blocks, and four tutorial snippets.

@Rigidity
Rigidity merged commit 927fb58 into main Nov 16, 2026
3 checks passed
@Rigidity
Rigidity deleted the rigidity/update-rue-docs-skill branch November 16, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant